Finance APIs

GET finance/bank-accounts

List of bank accounts used by the current company

HTTP method	GET
URI	https://api.rambase.net/finance/bank-accounts
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	493, version 16

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

AccountNumber String	Account number used to identify the bank account.
BankAccountId Integer	Bank account identifier.
Currency String	Currency used for the bank account.
GeneralLedgerAccountId Integer	General ledger account identifier.
IBAN String	The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.
ImportBankStatements Boolean	Indicates if the bank statements will be handled via the BankConnector.
Name String	Name of bank account.
Status Integer	Status of bank account.
SWIFTCode String	The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments..

Read more about filters and sorting on how to use sortable parameters

AccountNumber String	Account number used to identify the bank account
BankAccountId Integer	Bank account identifier
Currency String	Currency used for the bank account
GeneralLedgerAccountId Integer	General ledger account identifier
IBAN String	The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.
ImportBankStatements Boolean	Indicates if the bank statements will be handled via the BankConnector
Name String	Name of bank account
Status Integer	Status of bank account
SWIFTCode String	The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <BankAccounts>
                                    

                                             <BankAccount>
                                    

<BankAccountId

BankAccountId

Bank account identifier

>{Integer}</BankAccountId>

<Status

Status

Status of bank account

Possible domain values can be found here

>{Integer}</Status>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Name

Name

Name of bank account

>{String}</Name>

<AccountNumber

AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>

<Type

Type

Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...

Possible domain values can be found here

>{String}</Type>

<Currency

Currency

Currency used for the bank account

Possible domain values can be found here

>{String}</Currency>

<IBAN

IBAN

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

>{String}</IBAN>

<RegionalId

RegionalId

Regional bank identifier of the bank account

>{String}</RegionalId>

<ExternalClearingSystemIdentificationCode

ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

<Code

Code

Clearing code of the bank account

Possible domain values can be found here

>{String}</Code>

<BankIdentifier

BankIdentifier

Clearing bank identifier of the bank account

>{String}</BankIdentifier>

                                                  </ExternalClearingSystemIdentificationCode>
                                    

                                                  <Bank>
                                    

<SWIFTCode

SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

>{String}</SWIFTCode>

<Phone

Phone

Bank phone number

>{String}</Phone>

<Address

Address

Address of the bank associated with the bank account

<AddressLine1

AddressLine1

First address line

>{String}</AddressLine1>

<AddressLine2

AddressLine2

Second address line

>{String}</AddressLine2>

<PostalCode

PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>

<City

City

City/town/village

>{String}</City>

<Country

Country

English name of country.

>{String}</Country>

<CountryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>

                                                       </Address>
                                    

                                                  </Bank>
                                    

<GeneralLedgerAccount

GeneralLedgerAccount

Finance account associated with the bank account

<GeneralLedgerAccountId

GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>

<AccountNumber

AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>

<Name

Name

Name of general ledger account

>{String}</Name>

<GeneralLedgerAccountLink

GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>

                                                  </GeneralLedgerAccount>
                                    

                                                  <IsUsedFor>
                                    

<Clearing

Clearing

Indicates if the bank account is used for clearing

>{Boolean}</Clearing>

<VATSettlement

VATSettlement

Indicates if the bank account is used for VAT settlement

>{Boolean}</VATSettlement>

<CreditCardTransaction

CreditCardTransaction

Indicates if the bank account can be used for credit card payments

>{Boolean}</CreditCardTransaction>

<Factoring

Factoring

Indicates if the bank account is used for factoring

>{Boolean}</Factoring>

                                                  </IsUsedFor>
                                    

                                                  <IsUsedOnOutput>
                                    

<SalesInvoice

SalesInvoice

Indicates if the bank account is used on print for outgoing invoices

>{Boolean}</SalesInvoice>

<ProformaInvoiceBasedOnSalesOrder

ProformaInvoiceBasedOnSalesOrder

Indicates if the bank account is used on print for proforma invoices, based on sales order

>{Boolean}</ProformaInvoiceBasedOnSalesOrder>

<ProformaInvoiceBasedOnShippingAdvice

ProformaInvoiceBasedOnShippingAdvice

Indicates if the bank account is used on print for proforma invoices, based on shipping advice

>{Boolean}</ProformaInvoiceBasedOnShippingAdvice>

<Dunning

Dunning

Indicates if the bank account is used on print for dunnings

>{Boolean}</Dunning>

                                                  </IsUsedOnOutput>
                                    

                                                  <PaymentTotals>
                                    

<Currency

Currency

Currency used for the bank account

>{String}</Currency>

<CurrentBalance

CurrentBalance

Opening balance for current year

>{Decimal}</CurrentBalance>

                                                  </PaymentTotals>
                                    

<BankAccountLink

BankAccountLink

Bank reference

>{String}</BankAccountLink>

                                             </BankAccount>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </BankAccounts>
                                    

{

                                             "bankAccounts": [
                                    

{

"bankAccountId

BankAccountId

Bank account identifier

": "{Integer}",

"status

Status

Status of bank account

Possible domain values can be found here

": "{Integer}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"name

Name

Name of bank account

": "{String}",

"accountNumber

AccountNumber

Account number used to identify the bank account

": "{String}",

"type

Type

Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...

Possible domain values can be found here

": "{String}",

"currency

Currency

Currency used for the bank account

Possible domain values can be found here

": "{String}",

"iBAN

IBAN

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

": "{String}",

"regionalId

RegionalId

Regional bank identifier of the bank account

": "{String}",

"externalClearingSystemIdentificationCode

ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

": {

"code

Code

Clearing code of the bank account

Possible domain values can be found here

": "{String}",

"bankIdentifier

BankIdentifier

Clearing bank identifier of the bank account

": "{String}"

},

                                                       "bank": {
                                    

"sWIFTCode

SWIFTCode

": "{String}",

"phone

Phone

Bank phone number

": "{String}",

"address

Address

Address of the bank associated with the bank account

": {

"addressLine1

AddressLine1

First address line

": "{String}",

"addressLine2

AddressLine2

Second address line

": "{String}",

"postalCode

PostalCode

Postalcode/Postcode/ZIP

": "{String}",

"city

City

City/town/village

": "{String}",

"country

Country

English name of country.

": "{String}",

"countryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"

}

},

"generalLedgerAccount

GeneralLedgerAccount

Finance account associated with the bank account

": {

"generalLedgerAccountId

GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",

"accountNumber

AccountNumber

The account number of the general ledger account

": "{String}",

"name

Name

Name of general ledger account

": "{String}",

"generalLedgerAccountLink

GeneralLedgerAccountLink

General ledger account reference

": "{String}"

},

                                                       "isUsedFor": {
                                    

"clearing

Clearing

Indicates if the bank account is used for clearing

": "{Boolean}",

"vATSettlement

VATSettlement

Indicates if the bank account is used for VAT settlement

": "{Boolean}",

"creditCardTransaction

CreditCardTransaction

Indicates if the bank account can be used for credit card payments

": "{Boolean}",

"factoring

Factoring

Indicates if the bank account is used for factoring

": "{Boolean}"

},

                                                       "isUsedOnOutput": {
                                    

"salesInvoice

SalesInvoice

Indicates if the bank account is used on print for outgoing invoices

": "{Boolean}",

"proformaInvoiceBasedOnSalesOrder

ProformaInvoiceBasedOnSalesOrder

Indicates if the bank account is used on print for proforma invoices, based on sales order

": "{Boolean}",

"proformaInvoiceBasedOnShippingAdvice

ProformaInvoiceBasedOnShippingAdvice

Indicates if the bank account is used on print for proforma invoices, based on shipping advice

": "{Boolean}",

"dunning

Dunning

Indicates if the bank account is used on print for dunnings

": "{Boolean}"

},

                                                       "paymentTotals": {
                                    

"currency

Currency

Currency used for the bank account

": "{String}",

"currentBalance

CurrentBalance

Opening balance for current year

": "{Decimal}"

},

"bankAccountLink

BankAccountLink

Bank reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101999 HTTP 404	Bank account not found
Error 104558 HTTP 400	The YEAR parameter is invalid